KFbxProperty Class Reference

#include <kfbxproperty.h>
Inheritance diagram for KFbxProperty:
Inheritance graph
[legend]

List of all members.

Detailed Description

Class to hold user properties.

Definition at line 64 of file kfbxproperty.h.


Constructor and Destructor.
typedef
FbxPropertyFlags::eFbxPropertyFlags 		 EFlags
static KFbxProperty  Create (KFbxProperty const &pCompoundProperty, KFbxDataType const &pDataType, char const *pName, char const *pLabel="", bool pCheckForDup=true, bool *pWasFound=NULL)
  Creates a runtime property on the specified property.
static KFbxProperty  Create (KFbxObject *pObject, KFbxDataType const &pDataType, char const *pName, char const *pLabel="", bool pCheckForDup=true, bool *pWasFound=NULL)
  Creates a runtime property on the specified object.
static KFbxProperty  CreateFrom (KFbxProperty const &pCompoundProperty, KFbxProperty &pFromProperty, bool pCheckForDup=true)
  Creates a dynamic property from another property on the specified property.
static KFbxProperty  CreateFrom (KFbxObject *pObject, KFbxProperty &pFromProperty, bool pCheckForDup=true)
  Creates a dynamic property from another property on the specified object.
void  Destroy ()
  Destroys a dynamic property.
void  DestroyRecursively ()
  Destroys a dynamic property and its children.
void  DestroyChildren ()
  Destroys children of a dynamic property.
  KFbxProperty ()
  Static property constructor.
  KFbxProperty (KFbxProperty const &pProperty)
  Copy constructor for properties.
  KFbxProperty (KFbxPropertyHandle const &pPropertyHandle)
  Copy constructor for properties.
  ~KFbxProperty ()
  Static property destructor.

Value management.
static bool  HasDefaultValue (KFbxProperty &pProperty)
  Checks if the specified property's value has changed from its default value.
bool  IsValid () const
  Judges the property's validity.
bool  Set (void const *pValue, EFbxType pValueType, bool pCheckForValueEquality)
  Sets the value of this property.
bool  Set (void const *pValue, EFbxType pValueType)
  Sets the value of this function.
bool  Get (void *pValue, EFbxType pValueType) const
  Returns the value of the property.
template<class T>
bool  Set (T const &pValue)
  Sets the value of the property.
template<class T>
T  Get (T const *pFBX_TYPE) const
  Gets the value of the property.
KFbxInheritType  GetValueInheritType () const
  Queries the inheritance type of the property.
bool  SetValueInheritType (KFbxInheritType pType)
  Sets the inheritance type of the property.
bool  Modified () const
  Checks if the property's value has been modified from its default value.

Property Identification.
KFbxDataType  GetPropertyDataType () const
  Returns the property data type.
KString  GetName () const
  Returns the internal name of the property.
KString  GetHierarchicalName () const
  Returns the hierarchical name of the property.
KString  GetLabel (bool pReturnNameIfEmpty=true) const
  Returns the property label.
void  SetLabel (const KString &pLabel)
  Sets a label for the property.
KFbxObject *  GetFbxObject () const
  Returns the object that contains the property.

User data
void  SetUserTag (int pTag)
  Sets the user tag.
int  GetUserTag ()
  Gets the user tag.
void  SetUserDataPtr (void *pUserData)
  Sets the user data pointer.
void *  GetUserDataPtr ()
  Gets the user data pointer.

Property Flags.
void  ModifyFlag (eFbxPropertyFlags pFlag, bool pValue)
  Changes the property attribute.
bool  GetFlag (eFbxPropertyFlags pFlag) const
  Returns the state of the property attribute.
KFbxInheritType  GetFlagInheritType (eFbxPropertyFlags pFlag) const
  Returns the inheritance type of the given flag, similar to GetValueInheritType().
bool  SetFlagInheritType (eFbxPropertyFlags pFlag, KFbxInheritType pType)
  Sets the inheritance type for the specific flag, similar to SetValueInheritType().
bool  ModifiedFlag (eFbxPropertyFlags pFlag) const
  Checks if the property flag has been modified from its default value.

Assignment and comparison operators
KFbxProperty &  operator= (KFbxProperty const &pKProperty)
  Assignment operator.
bool  operator== (KFbxProperty const &pKProperty) const
  Equivalence operator.
bool  operator!= (KFbxProperty const &pKProperty) const
  Non-equivalence operator.
bool  operator== (int pValue) const
  Equivalence operator.
bool  operator!= (int pValue) const
  Non-equivalence operator.
bool  CompareValue (KFbxProperty const &pProp) const
  Compares this property's value to another property's value.

Property Limits.
Property limits are provided for convenience if some applications desire to bound the range of possible values for a given type property.

Note: These limits are meaningless for the boolean type. It is the responsibility of the calling application to implement the necessary instructions to limit the property of boolean type.
void  SetMinLimit (double pMin)
  Sets a minimum property value limit.
bool  HasMinLimit () const
  Returns whether a minimum limit exists, if it returns false, calling GetMinLimit() produces undefined behavior.
double  GetMinLimit () const
  Returns the minimum property value limit.
bool  HasMaxLimit () const
  Returns whether a maximum limit exists, if it returns false, calling GetMaxLimit() produces undefined behavior.
void  SetMaxLimit (double pMax)
  Sets a maximum property value limit.
double  GetMaxLimit () const
  Returns the maximum property value.
void  SetLimits (double pMin, double pMax)
  Sets the minimum and maximum value limit of the property.

Enum and property list
int  AddEnumValue (char const *pStringValue)
  Adds a string value at the end of the enumeration list.
void  InsertEnumValue (int pIndex, char const *pStringValue)
  Inserts a string value at the specific index.
int  GetEnumCount () const
  Returns the number of elements in the enumeration list.
void  SetEnumValue (int pIndex, char const *pStringValue)
  Sets a string value at the specific index.
void  RemoveEnumValue (int pIndex)
  Removes the string value at the specified index.
const char *  GetEnumValue (int pIndex) const
  Returns a string value at the specified index.

Hierarchical properties
bool  IsRoot () const
  Judges if this property is the root property.
bool  IsChildOf (KFbxProperty const &pParent) const
  Judges whether this property is a child of the specified property.
bool  IsDescendentOf (KFbxProperty const &pAncestor) const
  Judges whether this property is a descendant of the specified property.
KFbxProperty  GetParent () const
  Returns the parent property of this property.
bool  SetParent (const KFbxProperty &pOther)
  Sets the parent for this property (this function has not been implemented, so it always return false).
KFbxProperty  GetChild () const
  Returns the first child of this property.
KFbxProperty  GetSibling () const
  Returns the sibling of this property.
KFbxProperty  GetFirstDescendent () const
  Returns the first property that is a descendant of this property.
KFbxProperty  GetNextDescendent (KFbxProperty const &pProperty) const
  Returns the property that follows pProperty that is a descendant of this property.
KFbxProperty  Find (char const *pName, bool pCaseSensitive=true) const
  Searches a property using its name.
KFbxProperty  Find (char const *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const
  Searches a property using its name and data type.
KFbxProperty  FindHierarchical (char const *pName, bool pCaseSensitive=true) const
  Searches a property using its full name.
KFbxProperty  FindHierarchical (char const *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const
  Searches a property using its full name and data type.

Optimizations
void  BeginCreateOrFindProperty ()
  Internal function for building a property name map.
void  EndCreateOrFindProperty ()
  Internal function for clearing the property name map.

Array Management
bool  SetArraySize (int pSize, bool pVariableArray)
  Sets the array size(not implemented).
int  GetArraySize () const
  Returns the array size(not implemented).
KFbxProperty  GetArrayItem (int pIndex) const
  Returns the (pIndex)th array item.
KFbxProperty  operator[] (int pIndex) const
  Returns the (pIndex)th array item.

FCurve Management
K_DEPRECATED KFCurveNode *  CreateKFCurveNode (const char *pTakeName=NULL)
  Creates a KFCurveNode on a take.
K_DEPRECATED KFCurveNode *  GetKFCurveNode (bool pCreateAsNeeded=false, const char *pTakeName=NULL)
  Returns the KFCurveNode of the property from a take.
K_DEPRECATED KFCurve *  GetKFCurve (const char *pChannel=NULL, bool pCreateAsNeeded=true)
  Tries to get the KFCurve of the specified channel from the current take.
K_DEPRECATED KFCurve *  GetKFCurve (const char *pChannel, const char *pTakeName, bool pCreateAsNeeded=true)
  Tries to get the KFCurve of the specified channel from the given take.

Curve Management
KFbxAnimCurveNode *  CreateCurveNode (KFbxAnimLayer *pAnimLayer)
  Creates a KFbxAnimCurveNode on the specified layer.
KFbxAnimCurveNode *  GetCurveNode (KFbxAnimLayer *pAnimLayer, bool pCreateAsNeeded=false)
  Get the KFbxAnimCurveNode of the property that is connected to the specified animation layer.
KFbxAnimCurveNode *  GetCurveNode (bool pCreateAsNeeded=false, const char *pAnimStackName=NULL)
  Use the animation stack name to look for the AnimStack and retrieves the first layer from the stack.
template<class T>
T *  GetCurve (KFbxAnimLayer *pAnimLayer, bool pCreateAsNeeded=false)
  Get the KFbxAnimCurve from the specified animation layer.
template<class T>
T *  GetCurve (KFbxAnimLayer *pAnimLayer, const char *pChannel, bool pCreateAsNeeded=false)
  Get the KFbxAnimCurve from the specified animation layer.
template<class T>
T *  GetCurve (KFbxAnimLayer *pAnimLayer, const char *pName, const char *pChannel, bool pCreateAsNeeded=false)
  Get the KFbxAnimCurve of the specified channel from the specified animation layer.

General Object Connection and Relationship Management
bool  ConnectSrcObject (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone)
  Connects this property to one source object.
bool  IsConnectedSrcObject (const KFbxObject *pObject) const
  Judges whether this property connects with the source object.
bool  DisconnectSrcObject (KFbxObject *pObject)
  Disconnects this property from one source object.
bool  DisconnectAllSrcObject ()
  Disconnects this property from all the source objects.
bool  DisconnectAllSrcObject (KFbxCriteria const &pCriteria)
  Disconnects this property from all source objects that satisfy a given criteria.
bool  DisconnectAllSrcObject (const kFbxClassId &pClassId)
  Disconnects this property from all the source objects of a specific class type.
bool  DisconnectAllSrcObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria)
  Disconnects this property from all the source objects of a specific class type that satisfy the given criteria.
int  GetSrcObjectCount () const
  Returns the number of source objects with which this property connects.
int  GetSrcObjectCount (KFbxCriteria const &pCriteria) const
  Returns the number of source objects that satisfy the given criteria with which this property connects.
int  GetSrcObjectCount (const kFbxClassId &pClassId) const
  Returns the number of source objects of the specific class type with which this property connects.
int  GetSrcObjectCount (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria) const
  Returns the number of source objects which are of the specified class type and satisfy the given criteria with which this property connects.
KFbxObject *  GetSrcObject (int pIndex=0) const
  Returns the source object at the specified index with which this property connects.
KFbxObject *  GetSrcObject (KFbxCriteria const &pCriteria, int pIndex=0) const
  Returns the source object that satisfies the criteria at the specified index with which this property connects.
KFbxObject *  GetSrcObject (const kFbxClassId &pClassId, int pIndex=0) const
  Returns the source object of the specified class type at the specified index with which this property connects.
KFbxObject *  GetSrcObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, int pIndex=0) const
  Returns the source object which is of the specified class type and satisfies the given criteria at the specified index.
KFbxObject *  FindSrcObject (const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name, starting with the specified index.
KFbxObject *  FindSrcObject (KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name which satisfies the given criteria, starting with the specified index.
KFbxObject *  FindSrcObject (const kFbxClassId &pClassId, const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name which is of the specified class type, starting with the specified index.
KFbxObject *  FindSrcObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.
template<class T>
bool  DisconnectAllSrcObject (T const *pFBX_TYPE)
  Disconnects this property from all source objects of the specified class type.
template<class T>
bool  DisconnectAllSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria)
  Disconnects this property from all source objects which are of the specified class type and satisfy the given criteria.
template<class T>
int  GetSrcObjectCount (T const *pFBX_TYPE) const
  Returns the number of source objects of a specific class type with which this property connects.
template<class T>
int  GetSrcObjectCount (T const *pFBX_TYPE, KFbxCriteria const &pCriteria) const
  Returns the number of source objects which are of the specified class type and satisfy the given criteria with which this property connects.
template<class T>
T *  GetSrcObject (T const *pFBX_TYPE, int pIndex=0) const
  Returns the source object of the specified class type at the specified index.
template<class T>
T *  GetSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, int pIndex=0) const
  Returns the source object which is of the specified class type and satisfies the given criteria at the specified index.
template<class T>
T *  FindSrcObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name which is of the specified class type, starting with the specified index.
template<class T>
T *  FindSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
  Searches the source object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.
bool  ConnectDstObject (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone)
  Connects this property to one destination object.
bool  IsConnectedDstObject (const KFbxObject *pObject) const
  Judges whether this property connects with the destination object.
bool  DisconnectDstObject (KFbxObject *pObject)
  Disconnects this property from the destination object.
bool  DisconnectAllDstObject ()
  Disconnects this property from all the destination objects.
bool  DisconnectAllDstObject (KFbxCriteria const &pCriteria)
  Disconnects this property from all the destination objects that satisfy given criteria.
bool  DisconnectAllDstObject (const kFbxClassId &pClassId)
  Disconnects this property from all the destination objects of the specified class type.
bool  DisconnectAllDstObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria)
  Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria.
int  GetDstObjectCount () const
  Returns the number of destination objects with which this property connects.
int  GetDstObjectCount (KFbxCriteria const &pCriteria) const
  Returns the number of destination objects that satisfy the given criteria with which this property connects.
int  GetDstObjectCount (const kFbxClassId &pClassId) const
  Returns the number of destination objects of the specified class type with which this property connects.
int  GetDstObjectCount (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria) const
  Returns the number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects.
KFbxObject *  GetDstObject (int pIndex=0) const
  Returns the destination object at the specified index with which this property connects.
KFbxObject *  GetDstObject (KFbxCriteria const &pCriteria, int pIndex=0) const
  Returns the destination object that satisfies given criteria at the specified index with which this property connects.
KFbxObject *  GetDstObject (const kFbxClassId &pClassId, int pIndex=0) const
  Returns the destination object of the specified class type at the specified index with which this property connects.
KFbxObject *  GetDstObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, int pIndex=0) const
  Returns the destination object which is of the specified class type and satisfies the given criteria at the specified index with which this property connects.
KFbxObject *  FindDstObject (const char *pName, int pStartIndex=0) const
  Searches the destination object with the specified name, starting with the specified index.
KFbxObject *  FindDstObject (KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
  Searches the destination object with the specified name which satisfies the given criteria, starting with the specified index.
KFbxObject *  FindDstObject (const kFbxClassId &pClassId, const char *pName, int pStartIndex=0) const
  Searches the destination object with the specified name which is of the specified class type, starting with the specified index.
KFbxObject *  FindDstObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
  Searches the destination object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.
template<class T>
bool  DisconnectAllDstObject (T const *pFBX_TYPE)
  Disconnects this property from all the destination objects of the specified class type.
template<class T>
bool  DisconnectAllDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria)
  Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria.
template<class T>
int  GetDstObjectCount (T const *pFBX_TYPE) const
  Returns the number of destination objects of the specified class type with which this property connects.
template<class T>
int  GetDstObjectCount (T const *pFBX_TYPE, KFbxCriteria const &pCriteria) const
  Returns the number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects.
template<class T>
T *  GetDstObject (T const *pFBX_TYPE, int pIndex=0) const
  Returns the destination object of the specified class type at the specified index with which this property connects.
template<class T>
T *  GetDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, int pIndex=0) const
  Returns the destination object which is of the specified class type and satisfies the given criteria at the specified index with which this property connects.
template<class T>
T *  FindDstObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const
  Searches the destination object with the specified name which is of the specified class type, starting with the specified index.
template<class T>
T *  FindDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
  Searches the destination object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.

General Property Connection and Relationship Management
bool  ConnectSrcProperty (KFbxProperty const &pProperty)
  Connects this property to a source property.
bool  IsConnectedSrcProperty (KFbxProperty const &pProperty)
  Judges whether this property connects with the specified source property.
bool  DisconnectSrcProperty (KFbxProperty const &pProperty)
  Disconnects this property from the specified source property.
int  GetSrcPropertyCount () const
  Returns the number of source properties with which this property connects.
KFbxProperty  GetSrcProperty (int pIndex=0) const
  Returns the source property at the specified index with which this property connects.
KFbxProperty  FindSrcProperty (const char *pName, int pStartIndex=0) const
  Searches the source property with the specified name, starting with the specified index with which this property connects.
bool  ConnectDstProperty (KFbxProperty const &pProperty)
  Connects this property to a destination property.
bool  IsConnectedDstProperty (KFbxProperty const &pProperty)
  Judges if this property connects with the specified destination property.
bool  DisconnectDstProperty (KFbxProperty const &pProperty)
  Disconnects this property from the specified destination property.
int  GetDstPropertyCount () const
  Returns the number of destination properties with which this property connects.
KFbxProperty  GetDstProperty (int pIndex=0) const
  Returns the destination property at the specified index with which this property connects.
KFbxProperty  FindDstProperty (const char *pName, int pStartIndex=0) const
  Searches the destination property with the specified name, starting with the specified index with which this property connects.
void  ClearConnectCache ()
  Clears the connection cache of this property, this cache is used to store the connections that satisfy the given criteria.

Public Member Functions
bool  CopyValue (KFbxProperty const &pProp)
  Copies the value of a property.

Static Public Attributes
static const char *  sHierarchicalSeparator
  Hierarchical separator of properties.

Classes
struct   KFbxPropertyNameCache
  This is an internal structure that you can use to build and clear the name map of properties. You can use the name map to speed up searching for property names. More...

Member Typedef Documentation

typedef FbxPropertyFlags::eFbxPropertyFlags EFlags

Definition at line 90 of file kfbxproperty.h.

Constructor & Destructor Documentation

KFbxProperty (  ) 

Static property constructor.

KFbxProperty ( KFbxProperty const &  pProperty  ) 

Copy constructor for properties.

Parameters:
pProperty  The property copied to this one.

KFbxProperty ( KFbxPropertyHandle const &  pPropertyHandle  ) 

Copy constructor for properties.

Parameters:
pPropertyHandle  The property handle copied to this property handle.

~KFbxProperty (  ) 

Static property destructor.

Member Function Documentation

static KFbxProperty Create ( KFbxProperty const &  pCompoundProperty,
KFbxDataType const &  pDataType,
char const *  pName,
char const *  pLabel = "",
bool  pCheckForDup = true,
bool *  pWasFound = NULL  
) [static]

Creates a runtime property on the specified property.

Parameters:
pCompoundProperty  The parent property of this property.
pDataType  The data type of this property.
pName  The property name.
pLabel  The label of this property.
pCheckForDup  If true, parent property checks if it has a child property already with pName, if false, the new property is created.
pWasFound  If pCheckForDup is true, this flag is set to indicate whether the pCompoundProperty already has a child property with pName.

Referenced by KFbxAnimCurveNode::AddChannel(), KFbxTypedProperty< fbxReference * >::StaticInit(), and KFbxTypedProperty< KFbxMarker::ELook >::StaticInit().

static KFbxProperty Create ( KFbxObject *  pObject,
KFbxDataType const &  pDataType,
char const *  pName,
char const *  pLabel = "",
bool  pCheckForDup = true,
bool *  pWasFound = NULL  
) [static]

Creates a runtime property on the specified object.

Parameters:
pObject  The object on which the property will be created.
pDataType  The data type of this property.
pName  The property name.
pLabel  The label of this property.
pCheckForDup  If true, pObject checks whether it already has a property with pName, if false, a new property is created.
pWasFound  If pCheckForDup is true, this flag is set to indicate whether the pObject already has a child property with pName.

static KFbxProperty CreateFrom ( KFbxProperty const &  pCompoundProperty,
KFbxProperty &  pFromProperty,
bool  pCheckForDup = true  
) [static]

Creates a dynamic property from another property on the specified property.

Parameters:
pCompoundProperty  The parent property of this property.
pFromProperty  The property copied by this property.
pCheckForDup  If true, parent property checks if it already has a child property that has the name of pFromProperty, if false, a new property is created.
Remarks:
Only the property name, label, min/max, enums and flags are copied.

static KFbxProperty CreateFrom ( KFbxObject *  pObject,
KFbxProperty &  pFromProperty,
bool  pCheckForDup = true  
) [static]

Creates a dynamic property from another property on the specified object.

Parameters:
pObject  The object that contains this property.
pFromProperty  The property copied by this property.
pCheckForDup  If true, pObject checks if it already has a property that has the name of pFromProperty, if false, a new property is created.
Remarks:
Only the property name, label, min/max, enums and flags are copied.

void Destroy (  ) 

Destroys a dynamic property.

void DestroyRecursively (  ) 

Destroys a dynamic property and its children.

Remarks:
Destroy all children of current property, and current property will also be destroyed.

void DestroyChildren (  ) 

Destroys children of a dynamic property.

Remarks:
Destroy all children of current property, and current property will not be destroyed.

KFbxDataType GetPropertyDataType (  )  const

Returns the property data type.

Returns:
The property data type.

KString GetName (  )  const

Returns the internal name of the property.

Returns:
Property internal name string.

Referenced by KFbxProcessorXRefCopy::KFbxPropertyUpdate::operator<().

KString GetHierarchicalName (  )  const

Returns the hierarchical name of the property.

Returns:
Property hierarchical name string.

KString GetLabel ( bool  pReturnNameIfEmpty = true  )  const

Returns the property label.

Parameters:
pReturnNameIfEmpty  If true, lets this method return the internal name if the label is empty.
Returns:
The property label if set, or the property internal name if the pReturnNameIfEmpty flag is set to true and the label has not been defined.
Remarks:
Some applications may ignore the label field and work uniquely with the internal name. Therefore, it should not be taken for granted that a label exists. Also, remember that the label does not get saved in the FBX file. It only exists while the property object is in memory.

void SetLabel ( const KString &  pLabel  ) 

Sets a label for the property.

Parameters:
pLabel  Label string.

KFbxObject* GetFbxObject (  )  const

Returns the object that contains the property.

Returns:
The property object owner (or null if the property is an orphan).

void SetUserTag ( int  pTag  ) 

Sets the user tag.

Parameters:
pTag  The user tag to be set.

int GetUserTag (  ) 

Gets the user tag.

void SetUserDataPtr ( void *  pUserData  ) 

Sets the user data pointer.

Parameters:
pUserData  The user data pointer.

void* GetUserDataPtr (  ) 

Gets the user data pointer.

Returns:
The user data pointer.

void ModifyFlag ( eFbxPropertyFlags  pFlag,
bool  pValue  
)

Changes the property attribute.

Parameters:
pFlag  Property attribute identifier.
pValue  New state of pFlag.

Referenced by KFbxTypedProperty< fbxReference * >::StaticInit(), and KFbxTypedProperty< KFbxMarker::ELook >::StaticInit().

bool GetFlag ( eFbxPropertyFlags  pFlag  )  const

Returns the state of the property attribute.

Parameters:
pFlag  Property attribute identifier.
Returns:
The state of the property attribute(pFlag).

KFbxInheritType GetFlagInheritType ( eFbxPropertyFlags  pFlag  )  const

Returns the inheritance type of the given flag, similar to GetValueInheritType().

Parameters:
pFlag  The flag to be queried.
Returns:
The inheritance type of the specific flag.

bool SetFlagInheritType ( eFbxPropertyFlags  pFlag,
KFbxInheritType  pType  
)

Sets the inheritance type for the specific flag, similar to SetValueInheritType().

Parameters:
pFlag  The flag to be set.
pType  The inheritance type to be set.
Returns:
True on success, false otherwise.

bool ModifiedFlag ( eFbxPropertyFlags  pFlag  )  const

Checks if the property flag has been modified from its default value.

Parameters:
pFlag  The flag to be queried.
Returns:
True if the value of this property has changed, false otherwise

KFbxProperty& operator= ( KFbxProperty const &  pKProperty  ) 

Assignment operator.

Parameters:
pKProperty  The property assigned to this property.
Returns:
This property.

bool operator== ( KFbxProperty const &  pKProperty  )  const

Equivalence operator.

Parameters:
pKProperty  The property compared to this property.
Returns:
True if equal, false otherwise.

bool operator!= ( KFbxProperty const &  pKProperty  )  const

Non-equivalence operator.

Parameters:
pKProperty  The property compared to this property.
Returns:
True if unequal, false otherwise.

bool operator== ( int  pValue  )  const [inline]

Equivalence operator.

Parameters:
pValue  The value compared to this property.
Returns:
True if this property is valid and pValue doesn't equal zero, or this property is invalid and pValue equals zero, false otherwise.

Definition at line 293 of file kfbxproperty.h.

bool operator!= ( int  pValue  )  const [inline]

Non-equivalence operator.

Parameters:
pValue  The value compared to this property.
Returns:
True if this property is valid and pValue equals zero, or this property is invalid and pValue doesn't equal zero, false otherwise.

Definition at line 299 of file kfbxproperty.h.

bool CompareValue ( KFbxProperty const &  pProp  )  const

Compares this property's value to another property's value.

Parameters:
pProp  The property whose value is compared with this property's value.
Returns:
True if equal, false otherwise.

bool CopyValue ( KFbxProperty const &  pProp  ) 

Copies the value of a property.

Parameters:
pProp  The property from which to derive the value.
Returns:
True if value has been copied successfully, false otherwise.

bool IsValid (  )  const

Judges the property's validity.

Returns:
True if this property is valid, false otherwise.

Referenced by KFbxAnimCurveNode::AddChannel(), GetBoundPropertyValue(), KFbxAnimCurveNode::GetChannelValue(), and KFbxAnimCurveNode::SetChannelValue().

static bool HasDefaultValue ( KFbxProperty &  pProperty  )  [static]

Checks if the specified property's value has changed from its default value.

Parameters:
pProperty  Property that is tested.
Returns:
True if the property value is still the default, false otherwise.
Remarks:
If the inheritance type of pProperty's value is eFbxOverride, pProperty's value should have been modified, so pProperty doesn't have the default value. If the inheritance type of pProperty's value is eFbxInherit, that means pProperty's value inherits the referenced object's property value, so pProperty has the default value.

bool Set ( void const *  pValue,
EFbxType  pValueType,
bool  pCheckForValueEquality  
)

Sets the value of this property.

Parameters:
pValue  Pointer to the new value
pValueType  The data type of the new value
pCheckForValueEquality  If true, the value is not set when it is equal to the default value.
Returns:
True if type is compatible and the value is set successfully, false otherwise.

Referenced by KFbxSet().

bool Set ( void const *  pValue,
EFbxType  pValueType  
) [inline]

Sets the value of this function.

Parameters:
pValue  Pointer to the new value
pValueType  The data type of the new value
Returns:
True if type is compatible and the value is set successfully, false otherwise.

Definition at line 348 of file kfbxproperty.h.

bool Get ( void *  pValue,
EFbxType  pValueType  
) const

Returns the value of the property.

Parameters:
pValue  Pointer to the value
pValueType  The data type of the value.
Returns:
True if type is compatible and value is returned successfully, false otherwise.

Referenced by KFbxGet().

bool Set ( T const &  pValue  )  [inline]

Sets the value of the property.

Parameters:
pValue  The new value
Returns:
True if type is compatible and the value is set successfully, false otherwise.

Reimplemented in KFbxTypedProperty.

Definition at line 361 of file kfbxproperty.h.

References FbxTypeOf().

T Get ( T const *  pFBX_TYPE  )  const [inline]

Gets the value of the property.

Parameters:
pFBX_TYPE  The data type of the value.
Returns:
The property value.

Definition at line 367 of file kfbxproperty.h.

References FbxTypeOf().

KFbxInheritType GetValueInheritType (  )  const

Queries the inheritance type of the property.

Use this method to determine if this property's value is overridden from the default value, or from the referenced object, if this object is a clone.

Returns:
The inheritance type of the property.

bool SetValueInheritType ( KFbxInheritType  pType  ) 

Sets the inheritance type of the property.

Use the method to explicitly override the default value of the property, or the referenced object's property value, if this object is a clone.

You can also use this to explicitly inherit the default value of the property, or the referenced object's property value, if this object is a clone.

Parameters:
pType  The new inheritance type.
Returns:
True on success, false otherwise.

bool Modified (  )  const

Checks if the property's value has been modified from its default value.

Returns:
True if the value of the property has changed, false otherwise.
Remarks:
If the inheritance type of the property's value is eFbxOverride, the property's value should have been modified, it returns true. If the inheritance type of the property's value is eFbxInherit, that means the property's value inherits the referenced object's property value, so the property's value is not modified and it returns false.

void SetMinLimit ( double  pMin  ) 

Sets a minimum property value limit.

Parameters:
pMin  Minimum value allowed.

bool HasMinLimit (  )  const

Returns whether a minimum limit exists, if it returns false, calling GetMinLimit() produces undefined behavior.

Returns:
True when a minimum limit exists, false otherwise.

double GetMinLimit (  )  const

Returns the minimum property value limit.

Returns:
The minimum value limit.

bool HasMaxLimit (  )  const

Returns whether a maximum limit exists, if it returns false, calling GetMaxLimit() produces undefined behavior.

Returns:
True when a maximum limit exists, false otherwise.

void SetMaxLimit ( double  pMax  ) 

Sets a maximum property value limit.

Parameters:
pMax  Maximum value allowed.

double GetMaxLimit (  )  const

Returns the maximum property value.

Returns:
The maximum value limit.

void SetLimits ( double  pMin,
double  pMax  
)

Sets the minimum and maximum value limit of the property.

Parameters:
pMin  Minimum value allowed.
pMax  Maximum value allowed.

int AddEnumValue ( char const *  pStringValue  ) 

Adds a string value at the end of the enumeration list.

Parameters:
pStringValue  The string value to be added.
Returns:
The index in the list where the string is added.
Remarks:
This function is only valid if the property type is eENUM. Empty strings are not allowed.

void InsertEnumValue ( int  pIndex,
char const *  pStringValue  
)

Inserts a string value at the specific index.

Parameters:
pIndex  Zero bound index.
pStringValue  The string value to be inserted.
Remarks:
This function is only valid if the property type is eENUM. pIndex must be in the range [0, ListValueGetCount()]. Empty strings are not allowed.

int GetEnumCount (  )  const

Returns the number of elements in the enumeration list.

Returns:
The number of elements in the enumeration list.
Remarks:
This function returns 0 if the property type is not eENUM.

void SetEnumValue ( int  pIndex,
char const *  pStringValue  
)

Sets a string value at the specific index.

Parameters:
pIndex  Zero bound index.
pStringValue  The string value at the specific index.
Remarks:
This function is only valid if the property type is eENUM. The function assigns the string value to the specific index. A string value must exist at the specific index in order to be changed. Empty strings are not allowed.

void RemoveEnumValue ( int  pIndex  ) 

Removes the string value at the specified index.

Parameters:
pIndex  Index of the string value to be removed.
Remarks:
This function is only valid if the property type is eENUM.

const char* GetEnumValue ( int  pIndex  )  const

Returns a string value at the specified index.

Parameters:
pIndex  Zero bound index.
Remarks:
This function is only valid if the property type is eENUM.

bool IsRoot (  )  const [inline]

Judges if this property is the root property.

Returns:
True when this property is a root property, false otherwise.

Definition at line 505 of file kfbxproperty.h.

bool IsChildOf ( KFbxProperty const &  pParent  )  const [inline]

Judges whether this property is a child of the specified property.

Parameters:
pParent  The specified property.
Returns:
True when this property is a child of the specified property, false otherwise.

Definition at line 511 of file kfbxproperty.h.

bool IsDescendentOf ( KFbxProperty const &  pAncestor  )  const [inline]

Judges whether this property is a descendant of the specified property.

Parameters:
pAncestor  The specified property.
Returns:
True when this property is a descendant of the specified property, false otherwise.

Definition at line 517 of file kfbxproperty.h.

KFbxProperty GetParent (  )  const [inline]

Returns the parent property of this property.

Returns:
The parent of this property.

Definition at line 522 of file kfbxproperty.h.

bool SetParent ( const KFbxProperty &  pOther  ) 

Sets the parent for this property (this function has not been implemented, so it always return false).

Parameters:
pOther  The parent to be set.
Returns:
True on success, false otherwise.

KFbxProperty GetChild (  )  const [inline]

Returns the first child of this property.

Returns:
The first child of this property, if there is none, an invalid property is returned.

Definition at line 533 of file kfbxproperty.h.

KFbxProperty GetSibling (  )  const [inline]

Returns the sibling of this property.

Returns:
The sibling of this property, if there is none, an invalid property is returned.

Definition at line 538 of file kfbxproperty.h.

KFbxProperty GetFirstDescendent (  )  const [inline]

Returns the first property that is a descendant of this property.

Returns:
The first descendant of this property, if there is none, an invalid property is returned.

Definition at line 543 of file kfbxproperty.h.

KFbxProperty GetNextDescendent ( KFbxProperty const &  pProperty  )  const [inline]

Returns the property that follows pProperty that is a descendant of this property.

Parameters:
pProperty  The last found descendant.
Returns:
The property that follows pProperty, if there is none, an invalid property is returned.

Definition at line 549 of file kfbxproperty.h.

KFbxProperty Find ( char const *  pName,
bool  pCaseSensitive = true  
) const [inline]

Searches a property using its name.

Parameters:
pName  The name of the property as a NULL terminated string.
pCaseSensitive  Whether the name is case-sensitive.
Returns:
A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 557 of file kfbxproperty.h.

KFbxProperty Find ( char const *  pName,
KFbxDataType const &  pDataType,
bool  pCaseSensitive = true  
) const [inline]

Searches a property using its name and data type.

Parameters:
pName  The name of the property as a NULL terminated string.
pDataType  The data type of the property.
pCaseSensitive  Whether the name is case-sensitive.
Returns:
A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 566 of file kfbxproperty.h.

References KFbxDataType::GetTypeInfoHandle().

KFbxProperty FindHierarchical ( char const *  pName,
bool  pCaseSensitive = true  
) const [inline]

Searches a property using its full name.

Parameters:
pName  The full name of the property as a NULL terminated string.
pCaseSensitive  whether the name is case-sensitive.
Returns:
A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 574 of file kfbxproperty.h.

KFbxProperty FindHierarchical ( char const *  pName,
KFbxDataType const &  pDataType,
bool  pCaseSensitive = true  
) const [inline]

Searches a property using its full name and data type.

Parameters:
pName  The full name of the property as a NULL terminated string.
pDataType  The data type of the property.
pCaseSensitive  whether the name is case-sensitive.
Returns:
A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 583 of file kfbxproperty.h.

References KFbxDataType::GetTypeInfoHandle().

void BeginCreateOrFindProperty (  )  [inline]

Internal function for building a property name map.

Definition at line 592 of file kfbxproperty.h.

void EndCreateOrFindProperty (  )  [inline]

Internal function for clearing the property name map.

Definition at line 595 of file kfbxproperty.h.

bool SetArraySize ( int  pSize,
bool  pVariableArray  
)

Sets the array size(not implemented).

Parameters:
pSize 
pVariableArray 

int GetArraySize (  )  const

Returns the array size(not implemented).

KFbxProperty GetArrayItem ( int  pIndex  )  const

Returns the (pIndex)th array item.

Parameters:
pIndex  The item index.
Returns:
The (pIndex)th array item.

KFbxProperty operator[] ( int  pIndex  )  const [inline]

Returns the (pIndex)th array item.

Parameters:
pIndex  The item index.
Returns:
The (pIndex)th array item.

Definition at line 645 of file kfbxproperty.h.

K_DEPRECATED KFCurveNode* CreateKFCurveNode ( const char *  pTakeName = NULL  ) 

Creates a KFCurveNode on a take.

Parameters:
pTakeName  Name of the take to create the KFCurveNode on.

K_DEPRECATED KFCurveNode* GetKFCurveNode ( bool  pCreateAsNeeded = false,
const char *  pTakeName = NULL  
)

Returns the KFCurveNode of the property from a take.

Parameters:
pTakeName  Name of the take from which to get the KFCurveNode.
pCreateAsNeeded  Creates a KFCurveNode if not found.
Returns:
Pointer to the KFCurveNode of the property on the given take.
Remarks:
The returned pointer is not persistent and should not be stored for later use.

K_DEPRECATED KFCurve* GetKFCurve ( const char *  pChannel = NULL,
bool  pCreateAsNeeded = true  
)

Tries to get the KFCurve of the specified channel from the current take.

Parameters:
pChannel  Name of the KFCurve channel we are looking for.
pCreateAsNeeded  Creates a KFCurveNode if not found.
Returns:
Pointer to the KFCurve of the specified channel if found, NULL in any other case.
Remarks:
This method fails if the KFCurveNode does not exist. If the pChannel is left NULL, this method retrieves the KFCurve directly from the KFCurveNode of the property, Otherwise it searches recursively to find the KFCurve of the specified channel.

K_DEPRECATED KFCurve* GetKFCurve ( const char *  pChannel,
const char *  pTakeName,
bool  pCreateAsNeeded = true  
)

Tries to get the KFCurve of the specified channel from the given take.

Parameters:
pChannel  Name of the KFCurve channel we are looking for.
pTakeName  Name of the take from which to get the KFCurve.
pCreateAsNeeded  Creates a KFCurve if not found.
Returns:
Pointer to the KFCurve if found, NULL in any other case.
Remarks:
This method fails if the KFCurveNode does not exist. If pTakeName is NULL, this function searches in the current take. If the pChannel is left NULL, this method retrieves the KFCurve directly from the KFCurveNode of the property. Otherwise it searches recursively to find the KFCurve of the specified channel.

KFbxAnimCurveNode* CreateCurveNode ( KFbxAnimLayer *  pAnimLayer  ) 

Creates a KFbxAnimCurveNode on the specified layer.

Parameters:
pAnimLayer  The animation layer the KFbxAnimCurveNode object is attached to.
Returns:
Pointer to the created KFbxAnimCurveNode.
Remarks:
This function check the property eANIMATABLE flag and fails to execute if it is not set.

If created, the KFbxAnimCurveNode is automatically connected to the property and the animation layer.

The created KFbxAnimCurveNode does not automatically allocate anim curves.

On the successful execution of this function, the property ePUBLISHED flag is set to true.

KFbxAnimCurveNode* GetCurveNode ( KFbxAnimLayer *  pAnimLayer,
bool  pCreateAsNeeded = false  
)

Get the KFbxAnimCurveNode of the property that is connected to the specified animation layer.

Parameters:
pAnimLayer  The searched animation layer.
pCreateAsNeeded  Creates a KFbxAnimCurveNode if it does not exist.
Returns:
Pointer to the created KFbxAnimCurveNode or NULL if an error occurred.
Remarks:
This function check the property eANIMATABLE flag and fails to execute if it is not set.

If created, the KFbxAnimCurveNode is automatically connected to the property and the animation layer.

A created KFbxAnimCurveNode does not allocate anim curves.

KFbxAnimCurveNode* GetCurveNode ( bool  pCreateAsNeeded = false,
const char *  pAnimStackName = NULL  
)

Use the animation stack name to look for the AnimStack and retrieves the first layer from the stack.

This layer is then used to get the curve node.

Parameters:
pCreateAsNeeded  Creates a KFbxAnimCurveNode if it does not exist.
pAnimStackName  The name of the animation stack.

T* GetCurve ( KFbxAnimLayer *  pAnimLayer,
bool  pCreateAsNeeded = false  
) [inline]

Get the KFbxAnimCurve from the specified animation layer.

This function expects to find a KFbxAnimCurveNode object with the same name as the property and it attempts to retrieve the KFbxAnimCurve from it.

Parameters:
pAnimLayer  The searched animation layer.
pCreateAsNeeded  Create a KFbxAnimCurve if not found.
Returns:
Pointer to the KFbxAnimCurve. Returns NULL in case of errors or pCreateAsNeeded is false and the curve is not found.
Remarks:
If the KFbxAnimCurveNode does not exists but the property has the eANIMATABLE flag set and pCreateAsNeeded is true, then this function will first create the KFbxAnimCurveNode object and then the KFbxAnimCurve.

If more than one KFbxAnimCurveNode matching the name criteria are connected, the first one is returned.

Definition at line 737 of file kfbxproperty.h.

References NULL.

T* GetCurve ( KFbxAnimLayer *  pAnimLayer,
const char *  pChannel,
bool  pCreateAsNeeded = false  
) [inline]

Get the KFbxAnimCurve from the specified animation layer.

This function expects to find a KFbxAnimCurveNode object with the same name as the property and it attempts to retrieve the KFbxAnimCurve from it.

Parameters:
pAnimLayer  The searched animation layer.
pChannel  Name of the channel we are looking for the animation curve. If NULL use the first defined channel.
pCreateAsNeeded  Create a KFbxAnimCurve if not found.
Returns:
Pointer to the KFbxAnimCurve. Returns NULL in case of errors or pCreateAsNeeded is false and the curve is not found.
Remarks:
If the KFbxAnimCurveNode does not exists but the property has the eANIMATABLE flag set and pCreateAsNeeded is true, then this function will first create the KFbxAnimCurveNode object and then the KFbxAnimCurve.

If more than one KFbxAnimCurveNode matching the name criteria are connected, the first one is returned.

Definition at line 757 of file kfbxproperty.h.

T* GetCurve ( KFbxAnimLayer *  pAnimLayer,
const char *  pName,
const char *  pChannel,
bool  pCreateAsNeeded = false  
) [inline]

Get the KFbxAnimCurve of the specified channel from the specified animation layer.

This function looks for the KFbxAnimCurveNode named pName and the channel pChannel. It will retrieves the KFbxAnimCurve from it.

Parameters:
pAnimLayer  The searched animation layer.
pName  Name of the curve node. It is an error to leave this field empty.
pChannel  Name of the channel we are looking for the animation curve. If NULL use the first defined channel.
pCreateAsNeeded  Create a KFbxAnimCurve if not found.
Returns:
Pointer to the KFbxAnimCurve. Returns NULL in case of errors or pCreateAsNeeded is false and the curve is not found.
Remarks:
If the KFbxAnimCurveNode does not exists but the property has the eANIMATABLE flag set and pCreateAsNeeded is true, then this function will first create the KFbxAnimCurveNode object and then the KFbxAnimCurve.

If more than one KFbxAnimCurveNode matching the name criteria are connected, the first one is returned.

If pChannel is NULL, this function is the equivalent of GetCurve(KFbxAnimLayer*, bool).

Definition at line 779 of file kfbxproperty.h.

bool ConnectSrcObject ( KFbxObject *  pObject,
kFbxConnectionType  pType = eFbxConnectionNone  
)

Connects this property to one source object.

Parameters:
pObject  The source object to which this property connects.
pType  The connection type between the property and the object.
Returns:
True on success, false otherwise.

Referenced by KFbxTypedProperty< fbxReference * >::Set().

bool IsConnectedSrcObject ( const KFbxObject *  pObject  )  const

Judges whether this property connects with the source object.

Parameters:
pObject  The source object.
Returns:
True if this property connects with the source object, false otherwise.

bool DisconnectSrcObject ( KFbxObject *  pObject  ) 

Disconnects this property from one source object.

Parameters:
pObject  The source object from which this property will be disconnected.
Returns:
True on success, false otherwise.

bool DisconnectAllSrcObject (  ) 

Disconnects this property from all the source objects.

Returns:
True if it disconnects all the source objects successfully, false otherwise.

Referenced by KFbxTypedProperty< fbxReference * >::Set().

bool DisconnectAllSrcObject ( KFbxCriteria const &  pCriteria  ) 

Disconnects this property from all source objects that satisfy a given criteria.

Parameters:
pCriteria  The given criteria.
Returns:
True if it disconnects all the source objects successfully, false otherwise.

bool DisconnectAllSrcObject ( const kFbxClassId &  pClassId  ) 

Disconnects this property from all the source objects of a specific class type.

Parameters:
pClassId  The specific class type.
Returns:
True if it disconnects all the source objects successfully, false otherwise.

bool DisconnectAllSrcObject ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria  
)

Disconnects this property from all the source objects of a specific class type that satisfy the given criteria.

Parameters:
pClassId  The specific class type.
pCriteria  The given criteria.
Returns:
True if it disconnects all the source objects successfully, false otherwise.

int GetSrcObjectCount (  )  const

Returns the number of source objects with which this property connects.

Returns:
The number of source objects with which this property connects.

Referenced by KFbxTypedProperty< fbxReference * >::Get(), KFbxIteratorSrcBase::GetSafeNext(), KFbxIteratorSrcBase::GetSafePrevious(), KFbxIteratorSrcBase::ResetToBegin(), and KFbxIteratorSrcBase::ResetToEnd().

int GetSrcObjectCount ( KFbxCriteria const &  pCriteria  )  const

Returns the number of source objects that satisfy the given criteria with which this property connects.

Parameters:
pCriteria  The given criteria.
Returns:
The number of source objects that satisfy the given criteria with which this property connects.

int GetSrcObjectCount ( const kFbxClassId &  pClassId  )  const

Returns the number of source objects of the specific class type with which this property connects.

Parameters:
pClassId  The specific class type.
Returns:
The number of source objects of the specific class type with which this property connects.

int GetSrcObjectCount ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria  
) const

Returns the number of source objects which are of the specified class type and satisfy the given criteria with which this property connects.

Parameters:
pClassId  The specified class type.
pCriteria  The given criteria.
Returns:
The number of source objects.

KFbxObject* GetSrcObject ( int  pIndex = 0  )  const

Returns the source object at the specified index with which this property connects.

Parameters:
pIndex  The specified index whose default value is 0.
Returns:
The source object at the specified index, NULL if not found.

Referenced by KFbxTypedProperty< fbxReference * >::Get(), KFbxIteratorSrcBase::GetNext(), and KFbxIteratorSrcBase::GetPrevious().

KFbxObject* GetSrcObject ( KFbxCriteria const &  pCriteria,
int  pIndex = 0  
) const

Returns the source object that satisfies the criteria at the specified index with which this property connects.

Parameters:
pCriteria  The given criteria.
pIndex  The specified index whose default value is 0.
Returns:
The source object that satisfies the given criteria at the specified index, NULL if not found.

KFbxObject* GetSrcObject ( const kFbxClassId &  pClassId,
int  pIndex = 0  
) const

Returns the source object of the specified class type at the specified index with which this property connects.

Parameters:
pClassId  The specified class type.
pIndex  The specified index whose default value is 0.
Returns:
The source object of the specified class type at the specified index, NULL if not found.

KFbxObject* GetSrcObject ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria,
int  pIndex = 0  
) const

Returns the source object which is of the specified class type and satisfies the given criteria at the specified index.

Parameters:
pClassId  The specified class type.
pCriteria  The given criteria.
pIndex  The specified index whose default value is 0.
Returns:
The source object which is of the specified class type and satisfies the given criteria at the specified index, NULL if not found.

KFbxObject* FindSrcObject ( const char *  pName,
int  pStartIndex = 0  
) const

Searches the source object with the specified name, starting with the specified index.

Parameters:
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

KFbxObject* FindSrcObject ( KFbxCriteria const &  pCriteria,
const char *  pName,
int  pStartIndex = 0  
) const

Searches the source object with the specified name which satisfies the given criteria, starting with the specified index.

Parameters:
pCriteria  The given criteria.
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

KFbxObject* FindSrcObject ( const kFbxClassId &  pClassId,
const char *  pName,
int  pStartIndex = 0  
) const

Searches the source object with the specified name which is of the specified class type, starting with the specified index.

Parameters:
pClassId  The specified class type.
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

KFbxObject* FindSrcObject ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria,
const char *  pName,
int  pStartIndex = 0  
) const

Searches the source object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.

Parameters:
pClassId  The specified class type.
pCriteria  The given criteria.
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

bool DisconnectAllSrcObject ( T const *  pFBX_TYPE  )  [inline]

Disconnects this property from all source objects of the specified class type.

Parameters:
pFBX_TYPE  The specified class type.
Returns:
True if it disconnects all source objects successfully, false otherwise.

Definition at line 922 of file kfbxproperty.h.

bool DisconnectAllSrcObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria  
) [inline]

Disconnects this property from all source objects which are of the specified class type and satisfy the given criteria.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
Returns:
True if it disconnects all source objects successfully, false otherwise.

Definition at line 929 of file kfbxproperty.h.

int GetSrcObjectCount ( T const *  pFBX_TYPE  )  const [inline]

Returns the number of source objects of a specific class type with which this property connects.

Parameters:
pFBX_TYPE  The specified class type.
Returns:
The number of source objects of the specified class type with which this property connects.

Definition at line 935 of file kfbxproperty.h.

int GetSrcObjectCount ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria  
) const [inline]

Returns the number of source objects which are of the specified class type and satisfy the given criteria with which this property connects.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
Returns:
The number of source objects which are of the specified class type and satisfy the given criteria.

Definition at line 942 of file kfbxproperty.h.

T* GetSrcObject ( T const *  pFBX_TYPE,
int  pIndex = 0  
) const [inline]

Returns the source object of the specified class type at the specified index.

Parameters:
pFBX_TYPE  The specified class type.
pIndex  The specified index whose default value is 0.
Returns:
The source object of a specified class type at the specified index, NULL if not found.

Definition at line 949 of file kfbxproperty.h.

T* GetSrcObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
int  pIndex = 0  
) const [inline]

Returns the source object which is of the specified class type and satisfies the given criteria at the specified index.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
pIndex  The specified index whose default value is 0.
Returns:
The source object which is of the specified class type and satisfies the given criteria at the specified index, NULL if not found.

Definition at line 957 of file kfbxproperty.h.

T* FindSrcObject ( T const *  pFBX_TYPE,
const char *  pName,
int  pStartIndex = 0  
) const [inline]

Searches the source object with the specified name which is of the specified class type, starting with the specified index.

Parameters:
pFBX_TYPE  The specified class type.
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 965 of file kfbxproperty.h.

T* FindSrcObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
const char *  pName,
int  pStartIndex = 0  
) const [inline]

Searches the source object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 974 of file kfbxproperty.h.

bool ConnectDstObject ( KFbxObject *  pObject,
kFbxConnectionType  pType = eFbxConnectionNone  
)

Connects this property to one destination object.

Parameters:
pObject  The destination object with which this property connects.
pType  The connection type between this property and the object.
Returns:
True on success, false otherwise.

bool IsConnectedDstObject ( const KFbxObject *  pObject  )  const

Judges whether this property connects with the destination object.

Parameters:
pObject  The destination object.
Returns:
True if this property connects with the destination object, false otherwise.

bool DisconnectDstObject ( KFbxObject *  pObject  ) 

Disconnects this property from the destination object.

Parameters:
pObject  The destination object from which this property disconnects from.
Returns:
True on success, false otherwise.

bool DisconnectAllDstObject (  ) 

Disconnects this property from all the destination objects.

Returns:
True if it disconnects all the destination objects successfully, false otherwise.

bool DisconnectAllDstObject ( KFbxCriteria const &  pCriteria  ) 

Disconnects this property from all the destination objects that satisfy given criteria.

Parameters:
pCriteria  The given criteria.
Returns:
True if it disconnects all the destination objects successfully, false otherwise.

bool DisconnectAllDstObject ( const kFbxClassId &  pClassId  ) 

Disconnects this property from all the destination objects of the specified class type.

Parameters:
pClassId  The specified class type.
Returns:
True if it disconnects all the destination objects successfully, false otherwise.

bool DisconnectAllDstObject ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria  
)

Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria.

Parameters:
pClassId  The specified class type.
pCriteria  The given criteria.
Returns:
True if it disconnects all the destination objects successfully, false otherwise.

int GetDstObjectCount (  )  const

Returns the number of destination objects with which this property connects.

Returns:
The number of destination objects with which this property connects.

Referenced by KFbxIteratorDstBase::GetSafeNext(), KFbxIteratorDstBase::GetSafePrevious(), KFbxIteratorDstBase::ResetToBegin(), and KFbxIteratorDstBase::ResetToEnd().

int GetDstObjectCount ( KFbxCriteria const &  pCriteria  )  const

Returns the number of destination objects that satisfy the given criteria with which this property connects.

Parameters:
pCriteria  The given criteria.
Returns:
The number of destination objects that satisfy given criteria with which this property connects.

int GetDstObjectCount ( const kFbxClassId &  pClassId  )  const

Returns the number of destination objects of the specified class type with which this property connects.

Parameters:
pClassId  The specified class type.
Returns:
The number of destination objects of the specified class type with which this property connects.

int GetDstObjectCount ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria  
) const

Returns the number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects.

Parameters:
pClassId  The specified class type.
pCriteria  The given criteria.
Returns:
The number of destination objects which are of the specified class type and satisfy the given criteria.

KFbxObject* GetDstObject ( int  pIndex = 0  )  const

Returns the destination object at the specified index with which this property connects.

Parameters:
pIndex  The specified index whose default value is 0.
Returns:
The destination object at the specified index, NULL if not found.

Referenced by KFbxIteratorDstBase::GetNext(), and KFbxIteratorDstBase::GetPrevious().

KFbxObject* GetDstObject ( KFbxCriteria const &  pCriteria,
int  pIndex = 0  
) const

Returns the destination object that satisfies given criteria at the specified index with which this property connects.

Parameters:
pCriteria  The given criteria.
pIndex  The specified index whose default value is 0.
Returns:
The destination object that satisfies given criteria at the specified index, NULL if not found.

KFbxObject* GetDstObject ( const kFbxClassId &  pClassId,
int  pIndex = 0  
) const

Returns the destination object of the specified class type at the specified index with which this property connects.

Parameters:
pClassId  The specified class type.
pIndex  The specified index whose default value is 0.
Returns:
The destination object of the specified class type at the specified index, NULL if not found.

KFbxObject* GetDstObject ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria,
int  pIndex = 0  
) const

Returns the destination object which is of the specified class type and satisfies the given criteria at the specified index with which this property connects.

Parameters:
pClassId  The specified class type.
pCriteria  The given criteria.
pIndex  The specified index whose default value is 0.
Returns:
The destination object which is of the specified class type and satisfies the given criteria at the specified index, NULL if not found.

KFbxObject* FindDstObject ( const char *  pName,
int  pStartIndex = 0  
) const

Searches the destination object with the specified name, starting with the specified index.

Parameters:
pName  The object name.
pStartIndex  The start index.
Returns:
The destination object with the name, NULL if not found.

KFbxObject* FindDstObject ( KFbxCriteria const &  pCriteria,
const char *  pName,
int  pStartIndex = 0  
) const

Searches the destination object with the specified name which satisfies the given criteria, starting with the specified index.

Parameters:
pCriteria  The given criteria.
pName  The object name.
pStartIndex  The start index.
Returns:
The destination object with the name, NULL if not found.

KFbxObject* FindDstObject ( const kFbxClassId &  pClassId,
const char *  pName,
int  pStartIndex = 0  
) const

Searches the destination object with the specified name which is of the specified class type, starting with the specified index.

Parameters:
pClassId  The specified class type.
pName  The object name.
pStartIndex  The start index.
Returns:
The destination object with the name, NULL if not found.

KFbxObject* FindDstObject ( const kFbxClassId &  pClassId,
KFbxCriteria const &  pCriteria,
const char *  pName,
int  pStartIndex = 0  
) const

Searches the destination object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.

Parameters:
pClassId  The specified class type.
pCriteria  The given criteria.
pName  The object name.
pStartIndex  The start index.
Returns:
The destination object with the name, NULL if not found.

bool DisconnectAllDstObject ( T const *  pFBX_TYPE  )  [inline]

Disconnects this property from all the destination objects of the specified class type.

Parameters:
pFBX_TYPE  The specified class type.
Returns:
True if it disconnects all the destination objects successfully, false otherwise.

Definition at line 1108 of file kfbxproperty.h.

bool DisconnectAllDstObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria  
) [inline]

Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
Returns:
True if it disconnects all the destination objects successfully, false otherwise.

Definition at line 1115 of file kfbxproperty.h.

int GetDstObjectCount ( T const *  pFBX_TYPE  )  const [inline]

Returns the number of destination objects of the specified class type with which this property connects.

Parameters:
pFBX_TYPE  The specified class type.
Returns:
The number of destination objects of the specified class type with which this property connects.

Definition at line 1121 of file kfbxproperty.h.

int GetDstObjectCount ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria  
) const [inline]

Returns the number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
Returns:
The number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects.

Definition at line 1128 of file kfbxproperty.h.

T* GetDstObject ( T const *  pFBX_TYPE,
int  pIndex = 0  
) const [inline]

Returns the destination object of the specified class type at the specified index with which this property connects.

Parameters:
pFBX_TYPE  The specified class type.
pIndex  The specified index whose default value is 0.
Returns:
The destination object of the specified class type at the specified index, NULL if not found.

Definition at line 1135 of file kfbxproperty.h.

T* GetDstObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
int  pIndex = 0  
) const [inline]

Returns the destination object which is of the specified class type and satisfies the given criteria at the specified index with which this property connects.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
pIndex  The specified index whose default value is 0.
Returns:
The destination object which is of the specified class type and satisfies the given criteria at the specified index, NULL if not found.

Definition at line 1143 of file kfbxproperty.h.

T* FindDstObject ( T const *  pFBX_TYPE,
const char *  pName,
int  pStartIndex = 0  
) const [inline]

Searches the destination object with the specified name which is of the specified class type, starting with the specified index.

Parameters:
pFBX_TYPE  The specified class type.
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 1151 of file kfbxproperty.h.

T* FindDstObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
const char *  pName,
int  pStartIndex = 0  
) const [inline]

Searches the destination object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index.

Parameters:
pFBX_TYPE  The specified class type.
pCriteria  The given criteria.
pName  The object name.
pStartIndex  The start index.
Returns:
The source object with the name, NULL if not found.

Definition at line 1160 of file kfbxproperty.h.

bool ConnectSrcProperty ( KFbxProperty const &  pProperty  ) 

Connects this property to a source property.

Parameters:
pProperty  The source property with which this property connects.
Returns:
True on success, false otherwise.

bool IsConnectedSrcProperty ( KFbxProperty const &  pProperty  ) 

Judges whether this property connects with the specified source property.

Parameters:
pProperty  The specified source property.
Returns:
True if this property connects with the specified source property, false otherwise.

bool DisconnectSrcProperty ( KFbxProperty const &  pProperty  ) 

Disconnects this property from the specified source property.

Parameters:
pProperty  The specified source property.
Returns:
True on success, false otherwise.

int GetSrcPropertyCount (  )  const

Returns the number of source properties with which this property connects.

Returns:
The number of source properties with which this property connects.

KFbxProperty GetSrcProperty ( int  pIndex = 0  )  const

Returns the source property at the specified index with which this property connects.

Parameters:
pIndex  The specified index.
Returns:
The source property at the specified index.

KFbxProperty FindSrcProperty ( const char *  pName,
int  pStartIndex = 0  
) const

Searches the source property with the specified name, starting with the specified index with which this property connects.

Parameters:
pName  The specified property name.
pStartIndex  The start index.
Returns:
The source property with the specified name.

bool ConnectDstProperty ( KFbxProperty const &  pProperty  ) 

Connects this property to a destination property.

Parameters:
pProperty  The destination property with which this property connects.
Returns:
True on success, false otherwise.

bool IsConnectedDstProperty ( KFbxProperty const &  pProperty  ) 

Judges if this property connects with the specified destination property.

Parameters:
pProperty  The specified destination property.
Returns:
True if this property connects with the specified destination property, false otherwise.

bool DisconnectDstProperty ( KFbxProperty const &  pProperty  ) 

Disconnects this property from the specified destination property.

Parameters:
pProperty  The specified destination property.
Returns:
True on success, false otherwise.

int GetDstPropertyCount (  )  const

Returns the number of destination properties with which this property connects.

Returns:
The number of destination properties with which this property connects.

KFbxProperty GetDstProperty ( int  pIndex = 0  )  const

Returns the destination property at the specified index with which this property connects.

Parameters:
pIndex  The specified index.
Returns:
The destination property at the specified index.

KFbxProperty FindDstProperty ( const char *  pName,
int  pStartIndex = 0  
) const

Searches the destination property with the specified name, starting with the specified index with which this property connects.

Parameters:
pName  The specified property name.
pStartIndex  The start index.
Returns:
The destination property with the specified name.

void ClearConnectCache (  ) 

Clears the connection cache of this property, this cache is used to store the connections that satisfy the given criteria.

Member Data Documentation

const char* sHierarchicalSeparator [static]

Hierarchical separator of properties.

Definition at line 1247 of file kfbxproperty.h.

KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty
KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty